home *** CD-ROM | disk | FTP | other *** search
/ Developer CD Series 1997 January: Mac OS SDK / Dev.CD Jan 97 SDK2.toast / Development Kits (Disc 2) / OpenDoc Development Framework / ODFDev / ODF / Framewrk / FWViews / FWSclBar.cpp < prev    next >
Encoding:
Text File  |  1996-09-17  |  13.8 KB  |  474 lines  |  [TEXT/MPS ]
  1. //========================================================================================
  2. //
  3. //    File:                FWSclBar.cpp
  4. //    Release Version:    $ ODF 2 $
  5. //
  6. //    Copyright:    (c) 1993 - 1996 by Apple Computer, Inc., all rights reserved.
  7. //
  8. //========================================================================================
  9.  
  10. #include "FWFrameW.hpp"
  11.  
  12. #ifndef FWSCLBAR_H
  13. #include "FWSclBar.h"
  14. #endif
  15.  
  16. #ifndef FWFRAME_H
  17. #include "FWFrame.h"
  18. #endif
  19.  
  20. #ifndef FWPART_H
  21. #include "FWPart.h"
  22. #endif
  23.  
  24. #ifndef FWSCLNOT_H
  25. #include "FWSclNot.h"
  26. #endif
  27.  
  28. #ifndef FWNOTDEF_H
  29. #include "FWNotDef.h"
  30. #endif
  31.  
  32. #ifndef FWCONTXT_H
  33. #include "FWContxt.h"
  34. #endif
  35.  
  36. #ifndef FWSCROLR_H
  37. #include "FWScrolr.h"
  38. #endif
  39.  
  40. // ----- OS Layer -----
  41.  
  42. #ifndef FWEVENT_H
  43. #include "FWEvent.h"
  44. #endif
  45.  
  46. #ifndef FWFONT_H
  47. #include "FWFont.h"
  48. #endif
  49.  
  50. #ifndef FWODGEOM_H
  51. #include "FWODGeom.h"
  52. #endif
  53.  
  54. // ----- OpenDoc Includes -----
  55.  
  56. #ifndef SOM_ODSession_xh
  57. #include <ODSessn.xh>
  58. #endif
  59.  
  60. #ifndef SOM_ODFacet_xh
  61. #include <Facet.xh>
  62. #endif
  63.  
  64. #ifndef SOM_ODTransform_xh
  65. #include <Trnsform.xh>
  66. #endif
  67.  
  68. // ----- Platform Includes -----
  69.  
  70. #if defined(FW_BUILD_MAC) && !defined(__CONTROLS__)
  71. #include <Controls.h>
  72. #endif
  73.  
  74. #ifdef FW_BUILD_WIN
  75. #include <Windows.h>
  76. #endif
  77.  
  78. //========================================================================================
  79. // File scope definitions
  80. //========================================================================================
  81.  
  82. #ifdef FW_BUILD_MAC
  83. #pragma segment fwgadgts
  84. #endif
  85.  
  86. //========================================================================================
  87. // CLASS FW_CScrollBar
  88. //========================================================================================
  89.  
  90. FW_DEFINE_AUTO(FW_CScrollBar)
  91. FW_DEFINE_CLASS_M1(FW_CScrollBar, FW_CNativeControl)
  92.  
  93. // This class is archivable, but we provide the archiving implementation in a separate
  94. // translation unit in order to enable deadstripping of the archiving-related code
  95. // in parts that do not use archiving with this class.
  96.  
  97. //----------------------------------------------------------------------------------------
  98. // FW_CScrollBar::FW_CScrollBar
  99. //----------------------------------------------------------------------------------------
  100.  
  101. FW_CScrollBar::FW_CScrollBar(Environment* ev, 
  102.                              FW_CSuperView* container, 
  103.                              const FW_CRect& bounds,
  104.                              ODID viewID) :
  105.     FW_CNativeControl(ev, container, bounds, viewID),
  106.     fMinorScrollUnits(FW_kFixedPos1),
  107.     fMajorScrollUnits(FW_kFixedPos1),
  108.     fScroller(NULL)
  109. {
  110.     Initialize(ev, GetValue(ev), FW_CScrollBar::kDefaultScrollMin, FW_CScrollBar::kDefaultScrollMax);
  111.  
  112.     // Bind the scroll-bar to right or bottom egde of its superview by default
  113.     FW_ViewBinding    sbBindings = (bounds.Height() > bounds.Width()) ? 
  114.                 FW_kFixedWidth + FW_kRightBinding + FW_kTopBinding + FW_kBottomBinding :
  115.                 FW_kFixedHeight + FW_kRightBinding + FW_kLeftBinding + FW_kBottomBinding;
  116.     SetBindings(ev, sbBindings);
  117. }
  118.  
  119. //----------------------------------------------------------------------------------------
  120. // FW_CScrollBar::FW_CScrollBar
  121. //----------------------------------------------------------------------------------------
  122.  
  123. FW_CScrollBar::FW_CScrollBar(Environment* ev) :
  124.     FW_CNativeControl(ev),
  125.     fMinorScrollUnits(FW_kFixedPos1),
  126.     fMajorScrollUnits(FW_kFixedPos1),
  127.     fScroller(NULL)
  128. {
  129.     FW_END_CONSTRUCTOR
  130. }
  131.  
  132. //----------------------------------------------------------------------------------------
  133. // FW_CScrollBar::~FW_CScrollBar
  134. //----------------------------------------------------------------------------------------
  135.  
  136. FW_CScrollBar::~FW_CScrollBar()
  137. {
  138.     FW_START_DESTRUCTOR
  139. }
  140.  
  141. //----------------------------------------------------------------------------------------
  142. // FW_CScrollBar::Initialize
  143. //----------------------------------------------------------------------------------------
  144.  
  145. void FW_CScrollBar::Initialize(Environment *ev, FW_ControlValue value, FW_ControlValue min,
  146.                             FW_ControlValue max)
  147. {
  148.     FW_CRect bounds = GetBounds(ev);
  149.     FW_ViewBinding sbBindings = GetBindings(ev);
  150.     
  151.     // Ensure that width of vert. SB and height or horiz. SB are constant
  152.     if (bounds.Height() > bounds.Width())
  153.     {
  154.         sbBindings |= FW_kFixedWidth;
  155.     } 
  156.     else
  157.     {
  158.         sbBindings |= FW_kFixedHeight;
  159.     }
  160.     SetBindings(ev, sbBindings);
  161.  
  162.     // Create the control helper
  163. #ifdef FW_BUILD_MAC
  164.     fControlHelper = new FW_CPrivMacScrollBarControlHelper(ev, this, value, min, max, scrollBarProc);
  165. #endif
  166.  
  167. #ifdef FW_BUILD_WIN
  168.     // TO UPDATE
  169.     fControlHelper  = new FW_CPrivWinControlHelper
  170.                                 (ev, FW_TYPEID_FROM_TYPE(FW_CPrivWinScrollBarHelper), this);
  171. #endif
  172. }
  173.  
  174. //----------------------------------------------------------------------------------------
  175. // FW_CScrollBar::PrivSetValue
  176. //----------------------------------------------------------------------------------------
  177.  
  178. FW_Boolean FW_CScrollBar::PrivSetValue(Environment *ev, FW_ControlValue value, ODFacet* facet)
  179. {
  180.     // Update the native control.  Return false if value was not changed 
  181.     if (FW_CNativeControl::PrivSetValue(ev, value, facet))
  182.     {
  183.         // Send a control message to its receivers
  184.         if (GetMessage(ev) != FW_kScrollMsg && GetMessage(ev) != FW_kNullMsg)
  185.             Notify(ev, FW_CControlNotification(this));
  186.  
  187.         return true;
  188.     }
  189.     else
  190.         return false;
  191. }
  192.  
  193. //----------------------------------------------------------------------------------------
  194. // FW_CScrollBar::ControlClicked
  195. //----------------------------------------------------------------------------------------
  196.  
  197. void FW_CScrollBar::ControlClicked(Environment *ev, FW_ControlValue delta, ODFacet* facet)
  198. {    
  199.     // Update the control first
  200.     if (PrivSetValue(ev, GetValue(ev) + delta, facet))
  201.     {        
  202.         // Propagate the scrolling notification and ask to scroll
  203.         FW_Fixed fxDelta = FW_IntToFixed(delta);
  204.         ScrollPositionChanged(ev, fxDelta, true);
  205.     }
  206. }
  207.  
  208. //----------------------------------------------------------------------------------------
  209. // FW_CScrollBar::Direction
  210. //----------------------------------------------------------------------------------------
  211. //    Figure out which direction we're scrolling
  212.  
  213. FW_XYSelector FW_CScrollBar::ScrollingDirection(Environment *ev) const
  214. {
  215.     FW_CRect bounds = GetBounds(ev);
  216.     return (bounds.Height() > bounds.Width()) ? FW_kVertical : FW_kHorizontal;
  217. } 
  218.  
  219. //----------------------------------------------------------------------------------------
  220. // FW_CScrollBar::ScrollPositionChanged
  221. //----------------------------------------------------------------------------------------
  222.  
  223. void FW_CScrollBar::ScrollPositionChanged(Environment *ev, FW_Fixed delta, FW_Boolean shouldScroll)
  224. {
  225.     // ----- Notify receivers of the changes in scroll position
  226.     FW_CScrollNotification notification(this, ScrollingDirection(ev), delta, shouldScroll);
  227.     Notify(ev, notification);
  228. }
  229.  
  230. //----------------------------------------------------------------------------------------
  231. // FW_CScrollBar::GetDefaultScrollBarSize
  232. //----------------------------------------------------------------------------------------
  233.  
  234. FW_CPoint FW_CScrollBar::GetDefaultScrollBarSize()
  235. {
  236. #ifdef FW_BUILD_MAC
  237.     return FW_CPoint(FW_IntToFixed(15), FW_IntToFixed(15));
  238. #endif
  239. #ifdef FW_BUILD_WIN
  240.     return FW_CPoint(FW_IntToFixed(::GetSystemMetrics(SM_CXHSCROLL)),
  241.                      FW_IntToFixed(::GetSystemMetrics(SM_CXVSCROLL)));
  242. #endif
  243. }
  244.  
  245. //----------------------------------------------------------------------------------------
  246. // FW_CScrollBar::DoActivateEvent
  247. //----------------------------------------------------------------------------------------
  248.  
  249. void FW_CScrollBar::DoActivateEvent(Environment *ev, const FW_CActivateEvent& theActivateEvent)
  250. {
  251.     if (IsVisible(ev) == false)
  252.         return;
  253.  
  254. #ifdef FW_BUILD_MAC
  255.     ODFacet* facet = theActivateEvent.GetFacet(ev);
  256.     FW_CViewContext vc(ev, this, facet);
  257.  
  258.     FW_CPlatformPoint qdPoint    = vc.LogicalToDevice(FW_kZeroPoint);
  259.     FW_CPlatformPoint qdSize    = GetSize(ev).AsPlatformPoint();
  260.  
  261.     if (theActivateEvent.IsActivating(ev))
  262.     {    
  263.         // Draw scrollbar immediately
  264.         fControlHelper->Show(qdPoint, qdSize);
  265.     }
  266.     else
  267.     {
  268.         fControlHelper->Hide();
  269.         Draw(ev, facet, NULL);
  270.     }
  271. #endif
  272.  
  273. #ifdef FW_BUILD_WIN
  274.     // [TODO]
  275. #endif
  276. }
  277.  
  278. //----------------------------------------------------------------------------------------
  279. // FW_CScrollBar::SetMinorScrollUnits
  280. //----------------------------------------------------------------------------------------
  281.  
  282. void FW_CScrollBar::SetMinorScrollUnits(Environment *ev, FW_Fixed units)
  283. {
  284. FW_UNUSED(ev);
  285.     fMinorScrollUnits = units;
  286. }
  287.  
  288. //----------------------------------------------------------------------------------------
  289. // FW_CScrollBar::SetMajorScrollUnits
  290. //----------------------------------------------------------------------------------------
  291.  
  292. void FW_CScrollBar::SetMajorScrollUnits(Environment *ev, FW_Fixed units)
  293. {
  294. FW_UNUSED(ev);
  295.     fMajorScrollUnits = units;
  296. }
  297.  
  298. //----------------------------------------------------------------------------------------
  299. // FW_CScrollBar::SetScrollMax
  300. //----------------------------------------------------------------------------------------
  301.  
  302. void FW_CScrollBar::SetScrollMax(Environment *ev, FW_Fixed units)
  303. {
  304. FW_UNUSED(ev);
  305. #ifdef FW_BUILD_MAC
  306.     fControlHelper->SetMax(FW_FixedToInt(units));
  307. #endif
  308.  
  309. #ifdef FW_BUILD_WIN
  310.     // [TODO]
  311.     int min, max;
  312.     fScrollBarHelper->GetScrollRange(min, max);
  313.     fScrollBarHelper->SetScrollRange(min, FW_FixedToInt(units));
  314. #endif
  315. }
  316.  
  317. //----------------------------------------------------------------------------------------
  318. // FW_CScrollBar::SetScrollMin
  319. //----------------------------------------------------------------------------------------
  320.  
  321. void FW_CScrollBar::SetScrollMin(Environment *ev, FW_Fixed units)
  322. {
  323. FW_UNUSED(ev);
  324. #ifdef FW_BUILD_MAC
  325.     fControlHelper->SetMin(FW_FixedToInt(units));
  326. #endif
  327.  
  328. #ifdef FW_BUILD_WIN
  329.     // [TODO]
  330.     int min, max;
  331.     fScrollBarHelper->GetScrollRange(min, max);
  332.     fScrollBarHelper->SetScrollRange(FW_FixedToInt(units), max);
  333. #endif
  334. }
  335.  
  336. //----------------------------------------------------------------------------------------
  337. // FW_CScrollBar::SetScrollPos
  338. //----------------------------------------------------------------------------------------
  339.  
  340. void FW_CScrollBar::SetScrollPos(Environment *ev, FW_Fixed units)
  341. {
  342.     SetValue(ev, FW_FixedToInt(units));    
  343. }
  344.  
  345. //----------------------------------------------------------------------------------------
  346. // FW_CScrollBar::SetScrollPos
  347. //----------------------------------------------------------------------------------------
  348.  
  349. void FW_CScrollBar::SetScrollPos(Environment *ev, FW_Fixed range, FW_Fixed pos)
  350. {
  351.     FW_Fixed units = FW_kFixed0;
  352.     if (range != FW_kFixed0)
  353.         units = FW_WideMultiply(GetScrollMax(ev) - GetScrollMin(ev), pos) / range + GetScrollMin(ev);
  354.  
  355.     SetValue(ev, FW_FixedToInt(units));    
  356. }
  357.  
  358. //----------------------------------------------------------------------------------------
  359. //    FW_CScrollBar::Flatten
  360. //----------------------------------------------------------------------------------------
  361.  
  362. void FW_CScrollBar::Flatten(Environment* ev, FW_CWritableStream& stream) const
  363. {
  364.     FW_CNativeControl::Flatten(ev, stream);
  365.  
  366.     short min = fControlHelper->GetMin();
  367.     short max = fControlHelper->GetMax();
  368.     
  369.     stream << min;
  370.     stream << max;
  371.     stream << fMinorScrollUnits;
  372.     stream << fMajorScrollUnits;
  373. }
  374.  
  375. //----------------------------------------------------------------------------------------
  376. //    FW_CScrollBar::InitializeFromStream
  377. //----------------------------------------------------------------------------------------
  378.  
  379. void FW_CScrollBar::InitializeFromStream(Environment* ev, FW_CReadableStream& stream)
  380. {
  381.     FW_CNativeControl::InitializeFromStream(ev, stream);
  382.     
  383.     short min, max;
  384.     FW_Fixed major, minor;
  385.  
  386.     stream >> min >> max;
  387.     stream >> minor >> major;
  388.  
  389.     SetMinorScrollUnits(ev, minor);
  390.     SetMajorScrollUnits(ev, major);
  391.     
  392.     // [LSD] check for valid 16 bits value for scroll-bar
  393.     FW_ControlValue value = GetValue(ev);
  394.     FW_ASSERT(value <= FW_MAXINT16 && value >= FW_MININT16);
  395.  
  396.     Initialize(ev, value, min, max);
  397. }
  398.  
  399. //----------------------------------------------------------------------------------------
  400. // FW_CScrollBar::GetMinorScrollUnits
  401. //----------------------------------------------------------------------------------------
  402.  
  403. FW_Fixed FW_CScrollBar::GetMinorScrollUnits(Environment*) const
  404. {
  405.     return fMinorScrollUnits;
  406. }
  407.  
  408. //----------------------------------------------------------------------------------------
  409. // FW_CScrollBar::GetMajorScrollUnits
  410. //----------------------------------------------------------------------------------------
  411.  
  412. FW_Fixed FW_CScrollBar::GetMajorScrollUnits(Environment*) const
  413. {
  414.     return fMajorScrollUnits;
  415. }
  416.  
  417. //----------------------------------------------------------------------------------------
  418. // FW_CScrollBar::GetScrollMax
  419. //----------------------------------------------------------------------------------------
  420.  
  421. FW_Fixed FW_CScrollBar::GetScrollMax(Environment*) const
  422. {
  423. #ifdef FW_BUILD_MAC
  424.     return FW_IntToFixed(fControlHelper->GetMax());
  425. #endif
  426.  
  427. #ifdef FW_BUILD_WIN
  428.     int min, max;
  429.     fScrollBarHelper->GetScrollRange(min, max);
  430.     return FW_IntToFixed(max);
  431. #endif
  432. }
  433.  
  434. //----------------------------------------------------------------------------------------
  435. // FW_CScrollBar::GetScrollMin
  436. //----------------------------------------------------------------------------------------
  437.  
  438. FW_Fixed FW_CScrollBar::GetScrollMin(Environment*) const
  439. {
  440. #ifdef FW_BUILD_MAC
  441.     return FW_IntToFixed(fControlHelper->GetMin());
  442. #endif
  443.  
  444. #ifdef FW_BUILD_WIN
  445.     int min, max;
  446.     fScrollBarHelper->GetScrollRange(min, max);
  447.     return FW_IntToFixed(min);
  448. #endif
  449. }
  450.  
  451. //----------------------------------------------------------------------------------------
  452. // FW_CScrollBar::GetScrollPos
  453. //----------------------------------------------------------------------------------------
  454.  
  455. FW_Fixed FW_CScrollBar::GetScrollPos(Environment*) const
  456. {
  457. #ifdef FW_BUILD_MAC
  458.     return FW_IntToFixed(fControlHelper->GetValue());
  459. #endif
  460.  
  461. #ifdef FW_BUILD_WIN
  462.     return FW_IntToFixed(fScrollBarHelper->GetScrollPos());
  463. #endif
  464. }
  465.  
  466. //----------------------------------------------------------------------------------------
  467. // FW_CScrollBar::PrivAttachToScroller
  468. //----------------------------------------------------------------------------------------
  469.  
  470. void FW_CScrollBar::PrivAttachToScroller(Environment*ev, FW_CPrivBaseScroller* scroller)
  471. {
  472. FW_UNUSED(ev);
  473.     fScroller = scroller;
  474. }